<!--$Id: db_upgrade.so,v 10.37 2004/08/13 03:38:56 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db::upgrade</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b>Db::upgrade</b>
</td>
<td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>
#include &lt;db_cxx.h&gt;
<p>
int
Db::upgrade(const char *file, u_int32_t flags);
</pre></b>
<hr size=1 noshade>
<b>Description: Db::upgrade</b>
<p>The Db::upgrade method upgrades all of the databases included in the
file <b>file</b>, if necessary.  If no upgrade is necessary,
Db::upgrade always returns success.</p>
<p><b>Database upgrades are done in place and are destructive. For example,
if pages need to be allocated and no disk space is available, the
database may be left corrupted.  Backups should be made before databases
are upgraded.  See <a href="../ref/am/upgrade.html">Upgrading databases</a>
for more information.</b></p>
<p>Unlike all other database operations, Db::upgrade may only be done
on a system with the same byte-order as the database.</p>
<p>The Db::upgrade method
either returns a non-zero error value
or throws an exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</p>
<b>Parameters</b> <br>
 <b>file</b><ul compact><li>The <b>file</b> parameter is the physical file containing the databases
to be upgraded.</ul>
 <b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or
the following value:
<br>
<b><a name="DB_DUPSORT">DB_DUPSORT</a></b><ul compact><li><b>This flag is only meaningful when upgrading databases from
releases before the Berkeley DB 3.1 release.</b>
<p>As part of the upgrade from the Berkeley DB 3.0 release to the 3.1 release,
the on-disk format of duplicate data items changed.  To correctly
upgrade the format requires applications to specify whether duplicate
data items in the database are sorted or not.  Specifying the
DB_DUPSORT flag informs Db::upgrade that the duplicates
are sorted; otherwise they are assumed to be unsorted.  Incorrectly
specifying the value of this flag may lead to database corruption.</p>
<p>Further, because the Db::upgrade method upgrades a physical file
(including all the databases it contains), it is not possible to use
Db::upgrade to upgrade files in which some of the databases it
includes have sorted duplicate data items, and some of the databases it
includes have unsorted duplicate data items.  If the file does not have
more than a single database, if the databases do not support duplicate
data items, or if all of the databases that support duplicate data items
support the same style of duplicates (either sorted or unsorted),
Db::upgrade will work correctly as long as the
DB_DUPSORT flag is correctly specified.  Otherwise, the file
cannot be upgraded using Db::upgrade; it must be upgraded
manually by dumping and reloading the databases.</p></ul>
<br></ul>
<br>
<br><b>Environment Variables</b>
<p>If the database was opened within a database environment, the
environment variable <b>DB_HOME</b> may be used as the path of the
database environment home.</p>
<p>Db::upgrade is affected by any database directory specified using
the <a href="../api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a> method, or by setting the "set_data_dir" string
in the environment's <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.</p>
<br><b>Errors</b>
<p>The Db::upgrade method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<br>
<b><a name="DB_OLD_VERSION">DB_OLD_VERSION</a></b><ul compact><li>The database cannot be upgraded by this version of the Berkeley DB software.</ul>
<br>
<br>
<b>EINVAL</b><ul compact><li>If the database is not in the same byte-order as the system; or if an
invalid flag value or parameter was specified.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/db_class.html">Db</a>
<br><b>See Also</b>
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>
